API endpoints

Professional refrigerated storage cabinets

The base URL for all paths is https://create-energy-label.service.gov.uk. No authentication is required for any endpoints.

Professional refrigerated storage cabinets: arrow image

Path

/api/v1/professional-refrigerated-storage-cabinets/arrow-image

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property Description Type
productPriceHeightPx Enter height of the product's price (in pixels). This may be up to 3 digits long. Integer
labelOrientation Arrow direction.

Must be one of:
LEFT
RIGHT
String
labelFormat Image format.

Must be one of:
JPEG
PNG
String
efficiencyRating Energy efficiency class indicator.

Must be one of:
A+++
A++
A+
A
B
C
D
E
F
G
String

Example request body

{ "productPriceHeightPx": 100, "labelOrientation": "LEFT", "labelFormat": "JPEG", "efficiencyRating": "A+++" }

Professional refrigerated storage cabinets: energy label

You must display the label so that it’s easy to see and clearly related to the product. It must be at least 110mm x 220mm when printed.

Path

/api/v1/professional-refrigerated-storage-cabinets/energy-label

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property Description Type
outputFormat Format of the generated label. Optional, defaults to PDF if not set.

Must be one of:
PDF
PNG
JPEG
String
supplierName Supplier's name or trade mark. String
modelName Supplier's model identification code. String
efficiencyRating Energy efficiency class indicator.

Must be one of:
A+++
A++
A+
A
B
C
D
E
F
G
String
annualEnergyConsumption The annual electricity consumption in kWh in terms of final energy consumption per year. This may be up to 4 digits long. Integer
chilledCompartment Does this model have any compartments functioning at chilled operating temperature? Boolean
chilledVolume The sum of the net volumes, expressed in litres, of all chilled compartments functioning at chilled operating temperature. Only required if chilledCompartment is true. This may be up to 4 digits long. Integer
frozenCompartment Does this model have any compartments functioning at frozen operating temperature (or compartments declared as multi-use)? Boolean
frozenVolume The sum of the net volumes, expressed in litres, of all compartments functioning at frozen operating temperature (and of all compartments declared as multi-use). Only required if frozenCompartment is true. This may be up to 4 digits long. Integer
climateClass The climate class.

Must be one of:
3
4
5
String

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "efficiencyRating": "A+++", "annualEnergyConsumption": 1, "chilledCompartment": true, "chilledVolume": 1, "frozenCompartment": true, "frozenVolume": 1, "climateClass": "3" }